glance/doc/source/statuses.rst
Olena Logvinova 0142e27e91 [docs] Adds new image status - deactivated
This patch:

* adds a description of deactivated image status to
  http://docs.openstack.org/developer/glance/statuses.html
* updates the image with statuses on the same page.

Co-Authored-By: Mike Fedosin <mfedosin@mirantis.com>
Co-Authored-By: Olena Logvinova <ologvinova@mirantis.com>

Change-Id: Ic8aadd03b5d28744b8995701fe584e2647077b0b
Closes-Bug: #1503187
2015-10-14 14:11:42 +00:00

102 lines
3.1 KiB
ReStructuredText

..
Copyright 2010 OpenStack Foundation
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Image Statuses
==============
Images in Glance can be in one the following statuses:
* ``queued``
The image identifier has been reserved for an image in the Glance
registry. No image data has been uploaded to Glance and the image
size was not explicitly set to zero on creation.
* ``saving``
Denotes that an image's raw data is currently being uploaded to Glance.
When an image is registered with a call to `POST /images` and there
is an `x-image-meta-location` header present, that image will never be in
the `saving` status (as the image data is already available in some other
location).
* ``active``
Denotes an image that is fully available in Glance. This occurs when
the image data is uploaded, or the image size is explicitly set to
zero on creation.
* ``deactivated``
Denotes that access to image data is not allowed to any non-admin user.
Prohibiting downloads of an image also prohibits operations like image
export and image cloning that may require image data.
* ``killed``
Denotes that an error occurred during the uploading of an image's data,
and that the image is not readable.
* ``deleted``
Glance has retained the information about the image, but it is no longer
available to use. An image in this state will be removed automatically
at a later date.
* ``pending_delete``
This is similar to `deleted`, however, Glance has not yet removed the
image data. An image in this state is not recoverable.
.. figure:: /images/image_status_transition.png
:figwidth: 100%
:align: center
:alt: Image status transition
This is a representation of how the image move from one status to the next.
* Add location from zero to more than one.
* Remove location from one or more to zero by PATCH method which is only
supported in v2.
Task Statuses
==============
Tasks in Glance can be in one the following statuses:
* ``pending``
The task identifier has been reserved for a task in the Glance.
No processing has begun on it yet.
* ``processing``
The task has been picked up by the underlying executor and is being run
using the backend Glance execution logic for that task type.
* ``success``
Denotes that the task has had a successful run within Glance. The ``result``
field of the task shows more details about the outcome.
* ``failure``
Denotes that an error occurred during the execution of the task and it
cannot continue processing. The ``message`` field of the task shows what the
error was.