openstack
/
nova
Code Issues Proposed changes

Document the real behavior of notify_on_state_change 

The documentation of the notify_on_state_change config param was
incomplete and misleading. The code is untouched since
2012 so the document is updated to reflect the current behavior.

Change-Id: I51d0deffc4f42ff2722a8d21aa6b8c8008c62723
Closes-Bug: #1535254
(cherry picked from commit e86604fb65)
This commit is contained in:
Balazs Gibizer 2017-10-30 12:59:12 +01:00
parent 0b3187c9dc
commit 2c70ee8c72
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
nova/conf/notifications.py
View File

@ -32,17 +32,22 @@ ALL_OPTS = [
choices=(None, 'vm_state', 'vm_and_task_state'),
deprecated_group='DEFAULT',
help="""
If set, send compute.instance.update notifications on instance state
changes.
If set, send compute.instance.update notifications on
instance state changes.
Please refer to https://wiki.openstack.org/wiki/SystemUsageData for
Please refer to
https://docs.openstack.org/nova/latest/reference/notifications.html for
additional information on notifications.
Possible values:
* None - no notifications
* "vm_state" - notifications on VM state changes
* "vm_and_task_state" - notifications on VM and task state changes
* "vm_state" - notifications are sent with VM state transition information in
the ``old_state`` and ``state`` fields. The ``old_task_state`` and
``new_task_state`` fields will be set to the current task_state of the
instance.
* "vm_and_task_state" - notifications are sent with VM and task state
transition information.
"""),
cfg.BoolOpt(