From c395be176923df88ef3a7e6416832d84036b4789 Mon Sep 17 00:00:00 2001 From: Diane Fleming Date: Thu, 5 Apr 2012 16:14:59 -0500 Subject: [PATCH] Added descriptions of status for servers (list servers). Updated desc of RESCUE mode to remove Rackspace KC link. Patch #3 - updated status descriptions to remove shared IP Patch #4 - corrected "contact support" per Anne's request and added REVERT_RESIZE status Change-Id: Ic26fe76fe445e0b1e0c93cf67de27aa4544779fd --- openstack-compute-api-2/.gitignore | 3 + .../src/os-compute-devguide.xml | 211 +++++++++++++----- 2 files changed, 153 insertions(+), 61 deletions(-) create mode 100644 openstack-compute-api-2/.gitignore diff --git a/openstack-compute-api-2/.gitignore b/openstack-compute-api-2/.gitignore new file mode 100644 index 0000000..4488d7f --- /dev/null +++ b/openstack-compute-api-2/.gitignore @@ -0,0 +1,3 @@ +*.bak +*.DS_Store +target/ diff --git a/openstack-compute-api-2/src/os-compute-devguide.xml b/openstack-compute-api-2/src/os-compute-devguide.xml index becd293..b17e4cc 100644 --- a/openstack-compute-api-2/src/os-compute-devguide.xml +++ b/openstack-compute-api-2/src/os-compute-devguide.xml @@ -753,24 +753,32 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb Full Image Reference: JSON - - For convenience, resources contain links to + For convenience, resources contain links to themselves. This allows a client to easily obtain - resource URIs rather than to construct them. There - are three kinds of link relations associated with - resources. A self link contains a - versioned link to the resource. These links should be - used in cases where the link will be followed - immediately. A bookmark link provides a - permanent link to a resource that is appropriate for - long term storage. An alternate link can - contain an alternate representation of the resource. - For example, an OpenStack Compute image may have an - alternate representation in the OpenStack Image - service. Note that the type attribute here is used to - provide a hint as to the type of representation to - expect when following the link. - + rather than construct resource URIs. The following + types of link relations are associated with resources: + + A self link contains a + versioned link to the resource. Use these + links when the link will be followed + immediately. + + + A bookmark link provides a + permanent link to a resource that is + appropriate for long term storage. + + + An alternate link can + contain an alternate representation of the + resource. For example, an OpenStack + Compute image might have an alternate + representation in the OpenStack Image + service. + + Note that the type attribute here is + used to provide a hint as to the type of + representation to expect when following the link. Server with Self Links: XML @@ -1032,14 +1040,12 @@ X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb minute because the rate limits for any &POST; is 10/min. - - In the event a request exceeds the thresholds + In the event a request exceeds the thresholds established for your account, a - 413 HTTP response will be - returned with a Retry-After header to - notify the client when they can attempt to try - again. - + 413 HTTP response will + be returned with a Retry-After header + to notify the client when they can attempt to try + again.
@@ -1675,20 +1681,18 @@ Host: servers.api.openstack.org/v2/
Asynchronous Faults - - An error may occur in the background while a + An error may occur in the background while a server or image is being built or while a server - is executing an action. In these cases, the - server or image is placed in an ERROR - state and the fault is embedded in the offending - server or image. Note that these asynchronous - faults follow the same format as the synchronous - ones. The fault contains an error code, a human - readable message, and optional details about the - error. Additionally, asynchronous faults may also - contain a created timestamp that specify when the - fault occured. - + is executing an action. In these cases, the server + or image is placed in an ERROR state + and the fault is embedded in the offending server + or image. Note that these asynchronous faults + follow the same format as the synchronous ones. + The fault contains an error code, a human readable + message, and optional details about the error. + Additionally, asynchronous faults may also contain + a created timestamp that specify when the fault + occurred. Server In Error State: XML @@ -1820,40 +1824,134 @@ Host: servers.api.openstack.org/v2/ The server status, which is one of the following values: - ACTIVE + ACTIVE. The server is + active. - BUILD + BUILD. The server has + not finished the original build + process. + + + + DELETED. The server is + deleted. - DELETED + ERROR. The server is in + error. - ERROR + HARD_REBOOT. The server + is hard rebooting. This is + equivalent to pulling the power + plug on a physical server, plugging + it back in, and rebooting + it. - HARD_REBOOT + PASSWORD. The password + is being reset on the + server. + + + + + REBOOT. The server is + in a soft reboot state. A reboot + command was passed to the operating + system. - PASSWORD + REBUILD. The server is + currently being rebuilt from an + image. - REBOOT + RESCUE. The server is + in rescue mode. - REBUILD + RESIZE. Server is + performing the differential copy of + data that changed during its + initial copy. Server is down for + this stage. - RESIZE + REVERT_RESIZE. The + resize or migration of a server + failed for some reason. The + destination server is being cleaned + up and the original source server + is restarting. + + + + SUSPENDED. The server + is suspended, either by request or + for necessity. Review support + tickets or contact your cloud + provider to determine why the + server is in this state. - UNKNOWN + UNKNOWN. The state of + the server is unknown. Contact your + cloud provider. - VERIFY_RESIZE + VERIFY_RESIZE. System + is awaiting confirmation that the + server is operational after a move + or resize. @@ -1894,15 +1992,8 @@ Host: servers.api.openstack.org/v2/ attribute that can be used as an indication of the current server state. Servers with an ACTIVE status are available for - use. Other possible values for the status - attribute include: BUILD, - REBUILD, SUSPENDED, - RESIZE, - VERIFY_RESIZE, - PASSWORD, REBOOT, - HARD_REBOOT, - DELETED, UNKNOWN, and - ERROR. + use. See the definition of the status attribute + for a list of possible statuses. The compute provisioning algorithm has an anti-affinity property that attempts to spread customer VMs across hosts. Under certain @@ -3878,9 +3969,7 @@ Host: servers.api.openstack.org/v2/ the system. Specify the image ID as id in the URI. - Images are immediately removed. Currently, there - are no state transitions to track the delete - operation. + Images are immediately removed. This operation does not require a request body. This operation does not return a response body.