From 4a3be830afe04b6c26cf5a62d4ba989c65aa5a42 Mon Sep 17 00:00:00 2001 From: Paul Murray Date: Wed, 18 Nov 2015 14:59:40 +0000 Subject: [PATCH] docs: update the concept guide shelve actions The shelve_offload action is missing from the concept guide. This updates the description of the shelve actions to include shelve_offload. The text is slightly changed to keep the flow. blueprint complete-todo-in-api-concept-doc Change-Id: I15d574adfef5b604b5bf0fdfb254d703ac13e1bb --- api-guide/source/server_concepts.rst | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/api-guide/source/server_concepts.rst b/api-guide/source/server_concepts.rst index c9d4b093ad..6c9303db80 100644 --- a/api-guide/source/server_concepts.rst +++ b/api-guide/source/server_concepts.rst @@ -208,16 +208,25 @@ Server actions more than the CONF.reclaim_instance_interval, it will be deleted by compute service automatically. -- **Shelve**, **Unshelve** +- **Shelve**, **Shelve offload**, **Unshelve** - Shut down an instance and free it up to be removed from the hypervisors. - In some case others want to use the resource on some host, user can decide - whether need to shelve the instance into glance repository by using similar - method like snapshot to free up cpus, memory and disk space to the compute - host. + Shelving an instance indicates it will not be needed for some time and may be + temporarily removed from the hypervisors. This allows its resources to + be freed up for use by someone else. - Unshelve is the reverse operation of Shelve, build and boot the server again - with the shelved image in the glance repository on a new scheduled host. + Shelve will power off the given instance and take a snapshot if it is booted + from image. The instance can then be offloaded from the compute host and its + resources deallocated. Offloading is done immediately if booted from volume, + but if booted from image the offload can be delayed for some time or + indefinitely, leaving the image on disk and the resources still allocated. + + Shelve offload is used to explicitly remove a shelved instance that has been + left on a host. This action can only be used on a shelved instance and is + usually performed by an admin. + + Unshelve is the reverse operation of Shelve. It builds and boots the server + again, on a new scheduled host if it was offloaded, using the shelved image + in the glance repository if booted from image. - **Lock**, **Unlock** @@ -368,7 +377,7 @@ assigned at creation time. addresses may be updated after a server has been created. -**Example: Create server with multiple access IPs: JSON request** +**Example: Create server with multiple access IPs: JSON request** .. code::