Merge "Document update_task_state for ComputeDriver.snapshot"

This commit is contained in:
Jenkins 2016-09-20 11:33:11 +00:00 committed by Gerrit Code Review
commit c9de03a813
2 changed files with 7 additions and 1 deletions

View File

@ -3008,8 +3008,8 @@ class ComputeManager(manager.Manager):
"""Snapshot an instance on this host.
:param context: security context
:param instance: a nova.objects.instance.Instance object
:param image_id: glance.db.sqlalchemy.models.Image.Id
:param instance: a nova.objects.instance.Instance object
"""
# NOTE(dave-mcnally) the task state will already be set by the api
# but if the compute manager has crashed/been restarted prior to the

View File

@ -557,6 +557,12 @@ class ComputeDriver(object):
:param instance: nova.objects.instance.Instance
:param image_id: Reference to a pre-created image that will
hold the snapshot.
:param update_task_state: Callback function to update the task_state
on the instance while the snapshot operation progresses. The
function takes a task_state argument and an optional
expected_task_state kwarg which defaults to
nova.compute.task_states.IMAGE_SNAPSHOT. See
nova.objects.instance.Instance.save for expected_task_state usage.
"""
raise NotImplementedError()